Working with the Prizm Platform Services > Developer Reference - Prizm Services > PCC RESTful API > Flash Viewing |
Flash conversion to SWF.
Requests a document page in SWF format. The return object is a SWF object. Please note that flash API methods assumes a unique base64 encoding of the session Id. Please see the Prizm Services flash sample use of CommonCode.Encoder.EncodeURLString(vewingSessionId).
Http Method
GET
Resource URL
/PCCIS/V1/FlashViewer/Convert?fileName={EncodedViewingSessionId}&pageNumber={pageNumber}
Parameters
fileName |
The Viewing Session ID.encoded in a specific base64 format. |
pageNumber |
The page number for which SWF content will be returned. |
fidelity |
The fidelity to use for SWF conversion.
|
Request Body
Empty.
Response Body
If successful, this method returns the request SWF content.
Example |
Copy Code
|
---|---|
GET http://localhost:18681/PCCIS/V1/Convert?documentname=OABlA... &fileName=OABlA...&instanceid=8ADD1... &pageNumber=1&fidelity=low
|
Example Response |
Copy Code
|
---|---|
Empty |
Gets the actual page count.
The actual page count API returns a pages=<page count> in the response. The actual page count is the definitive page count but may be slow to retrieve. Depending on whether the application is using the Prizm Services service or not, the filename will need an encoded session Id or just the document file name. If Prizm Services is being used, encode the viewing session Id with CommonCode.Encoder.EncodeURLString(vewingSessionId).
Http Method
GET
Resource URL
/PCCIS/V1/FlashViewer/GetActualPageCount?documentname={EncodedViewingSessionId}&fileName={EncodedViewingSessionId}&instanceid={InstanceId}
Parameters
documentname |
The Viewing Session ID.encoded in a specific base64 format. |
fileName |
The Viewing Session ID.encoded in a specific base64 format. |
instanceId |
An instance ID defined by the Flash viewer. |
Request Body
Empty.
Response Body
If successful, this method returns the following properties:
Property Name |
Value |
Description |
pages |
Integer |
The actual number of pages in the document. |
Example |
Copy Code
|
---|---|
GET http://localhost:18681/PCCIS/V1/FlashViewer/ GetActualPageCount?documentname=OABlA... &fileName=OABlA...&instanceid=8ADD1...
|
Example Response |
Copy Code
|
---|---|
pages=3 |
Gets an estimated page count.
The estimated page count API returns a pages=<page count> in the response. The estimated page request is relatively fast but not necessarily accurate. Depending on whether the application is using the Prizm Services service or not, the filename will need an encoded session Id or just the document file name. If Prizm Services is being used, encode the viewing session Id with CommonCode.Encoder.EncodeURLString(vewingSessionId).
Http Method
GET
Resource URL
/PCCIS/V1/FlashViewer/GetEstimatedPageCount?documentname={EncodedViewingSessionId}&fileName={EncodedViewingSessionId}&instanceid={InstanceId}
Parameters
documentname |
The Viewing Session ID.encoded in a specific base64 format. |
fileName |
The Viewing Session ID.encoded in a specific base64 format. |
instanceId |
An instance ID defined by the Flash viewer. |
Request Body
Empty.
Response Body
If successful, this method returns the following properties:
Property Name |
Value |
Description |
pages |
Integer |
The estimated number of pages in the document. |
Example |
Copy Code
|
---|---|
GET http://localhost:18681/PCCIS/V1/FlashViewer/ GetEstimatedPageCount?documentname=OABlA...&fileName=OABlA... &instanceid=8ADD1...
|
Example Response |
Copy Code
|
---|---|
pages=3 |